<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SpringSQLSchemaUpdate.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.schema;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.sql.Connection;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.ArrayList;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.List;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>/**<a name="line.14"></a>
<span class="sourceLineNo">015</span> * Spring-enabled SQL {@link SchemaUpdate}.<a name="line.15"></a>
<span class="sourceLineNo">016</span> *<a name="line.16"></a>
<span class="sourceLineNo">017</span> * &lt;p&gt;<a name="line.17"></a>
<span class="sourceLineNo">018</span> * The {@link #setSQLCommandList sqlCommandList} property is required.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Instances can be created succintly in Spring using the &lt;code&gt;&amp;lt;dellroad-stuff:sql-update&amp;gt;&lt;/code&gt; custom XML element,<a name="line.21"></a>
<span class="sourceLineNo">022</span> * which works just like &lt;code&gt;&amp;lt;dellroad-stuff:sql&amp;gt;&lt;/code&gt; except that it wraps the resulting {@link SQLCommandList}<a name="line.22"></a>
<span class="sourceLineNo">023</span> * as a delegate inside an instance of this class.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * For example:<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *  &amp;lt;beans xmlns="http://www.springframework.org/schema/beans"<a name="line.28"></a>
<span class="sourceLineNo">029</span> *    &lt;b&gt;xmlns:dellroad-stuff="http://dellroad-stuff.googlecode.com/schema/dellroad-stuff"&lt;/b&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> *    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<a name="line.30"></a>
<span class="sourceLineNo">031</span> *    xsi:schemaLocation="<a name="line.31"></a>
<span class="sourceLineNo">032</span> *      http://www.springframework.org/schema/beans<a name="line.32"></a>
<span class="sourceLineNo">033</span> *        http://www.springframework.org/schema/beans/spring-beans-3.0.xsd<a name="line.33"></a>
<span class="sourceLineNo">034</span> *      &lt;b&gt;http://dellroad-stuff.googlecode.com/schema/dellroad-stuff<a name="line.34"></a>
<span class="sourceLineNo">035</span> *        http://dellroad-stuff.googlecode.com/svn/wiki/schemas/dellroad-stuff-1.0.xsd&lt;/b&gt;"&amp;gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> *      &amp;lt;!-- Schema update to add the 'phone' column to the 'User' table --&amp;gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *      &lt;b&gt;&amp;lt;dellroad-stuff:sql-update id="addPhone"&amp;gt;ALTER TABLE User ADD phone VARCHAR(64)&amp;lt;/dellroad-stuff:sql-update&amp;gt;&lt;/b&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> *      &amp;lt;!-- Schema update to run some complicated external SQL script --&amp;gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> *      &lt;b&gt;&amp;lt;dellroad-stuff:sql-update id="majorChanges" depends-on="addPhone" resource="classpath:majorChanges.sql"/&amp;gt;&lt;/b&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> *      &amp;lt;!-- more beans... --&amp;gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> *  &amp;lt;/beans&amp;gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;/p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;p&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * A multi-statement SQL script is normally treated as a set of individual updates. For example:<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> *      &lt;b&gt;&amp;lt;dellroad-stuff:sql-update id="renameColumn"&amp;gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> *          ALTER TABLE User ADD newName VARCHAR(64);<a name="line.53"></a>
<span class="sourceLineNo">054</span> *          ALTER TABLE User SET newName = oldName;<a name="line.54"></a>
<span class="sourceLineNo">055</span> *          ALTER TABLE User DROP oldName;<a name="line.55"></a>
<span class="sourceLineNo">056</span> *      &amp;lt;/dellroad-stuff:sql-update&amp;gt;&lt;/b&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * This will create three separate update beans named &lt;code&gt;renameColumn-00001&lt;/code&gt;, &lt;code&gt;renameColumn-00002&lt;/code&gt;, and<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;code&gt;renameColumn-00003&lt;/code&gt;. You can disable this behavior by adding the attribute &lt;code&gt;single-action="true"&lt;/code&gt;,<a name="line.59"></a>
<span class="sourceLineNo">060</span> * in which case all three of the statements will be executed together in the same transaction and recorded under the name<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;code&gt;renameColumn&lt;/code&gt;; this means that they must all complete successfully or you could end up with a partially<a name="line.61"></a>
<span class="sourceLineNo">062</span> * completed update.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;/p&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> *<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;p&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Note that if the nested SQL script only contains one SQL statement, any &lt;code&gt;single-action&lt;/code&gt; attribute is<a name="line.66"></a>
<span class="sourceLineNo">067</span> * ignored and the bean's given name (e.g., &lt;code&gt;renameColumn&lt;/code&gt;) is always used as the name of the single update.<a name="line.67"></a>
<span class="sourceLineNo">068</span> * &lt;/p&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @see SQLCommandList<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span>public class SpringSQLSchemaUpdate extends AbstractSpringSchemaUpdate&lt;Connection&gt; {<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>    private SQLCommandList sqlCommandList;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>    @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span>    public void afterPropertiesSet() throws Exception {<a name="line.77"></a>
<span class="sourceLineNo">078</span>        super.afterPropertiesSet();<a name="line.78"></a>
<span class="sourceLineNo">079</span>        if (this.sqlCommandList == null)<a name="line.79"></a>
<span class="sourceLineNo">080</span>            throw new Exception("no SQLCommandList configured");<a name="line.80"></a>
<span class="sourceLineNo">081</span>    }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>    /**<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * Configure the {@link SQLCommandList}. This is a required property.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     *<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * @see DatabaseAction<a name="line.86"></a>
<span class="sourceLineNo">087</span>     */<a name="line.87"></a>
<span class="sourceLineNo">088</span>    public void setSQLCommandList(SQLCommandList sqlCommandList) {<a name="line.88"></a>
<span class="sourceLineNo">089</span>        this.sqlCommandList = sqlCommandList;<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    public SQLCommandList getSQLCommandList() {<a name="line.92"></a>
<span class="sourceLineNo">093</span>        return this.sqlCommandList;<a name="line.93"></a>
<span class="sourceLineNo">094</span>    }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    @Override<a name="line.96"></a>
<span class="sourceLineNo">097</span>    public List&lt;DatabaseAction&lt;Connection&gt;&gt; getDatabaseActions() {<a name="line.97"></a>
<span class="sourceLineNo">098</span>        return new ArrayList&lt;DatabaseAction&lt;Connection&gt;&gt;(this.getSQLCommandList().split());<a name="line.98"></a>
<span class="sourceLineNo">099</span>    }<a name="line.99"></a>
<span class="sourceLineNo">100</span>}<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>




























































</pre>
</div>
</body>
</html>
